Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

change the name of a new enumeration in storage's latest api-version #20157

Merged
merged 3 commits into from
Aug 10, 2022
Merged

change the name of a new enumeration in storage's latest api-version #20157

merged 3 commits into from
Aug 10, 2022

Conversation

ArcturusZhang
Copy link
Member

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

Changelog

Add a changelog entry for this PR by answering the following questions:

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No refresh required for updates in this PR

Contribution checklist:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

  • Check this box if any of the following appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.

  • Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

  • If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

@openapi-workflow-bot
Copy link

Hi, @ArcturusZhang Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

    • Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 9, 2022 •
    edited
    Loading

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand] 
    There are no breaking changes.
    compared swaggers (via Oad v0.9.6)] new version base version
    blob.json 2022-05-01(fe54ce1) 2022-05-01(main)
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand] 
    There is no credential detected.
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    compared tags (via openapi-validator v1.13.0) new version base version
    package-2022-05 package-2022-05(fe54ce1) package-2022-05(main)

    The following errors/warnings exist before current PR submission:

    Only 30 items are listed, please refer to log for more details.

    Rule Message
    ❌ R3021 - PathResourceTypeNameCamelCase Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/{BlobServicesName}'
    Location: Microsoft.Storage/stable/2022-05-01/blob.json#L58
    ❌ R4010 - RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.Storage/stable/2022-05-01/blob.json#L45
    ❌ R4010 - RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.Storage/stable/2022-05-01/blob.json#L102
    ❌ R4010 - RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.Storage/stable/2022-05-01/blob.json#L139
    ❌ R4010 - RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.Storage/stable/2022-05-01/blob.json#L204
    ❌ R4010 - RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.Storage/stable/2022-05-01/blob.json#L261
    ❌ R4010 - RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.Storage/stable/2022-05-01/blob.json#L313
    ❌ R4010 - RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.Storage/stable/2022-05-01/blob.json#L354
    ❌ R4010 - RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.Storage/stable/2022-05-01/blob.json#L391
    ❌ R4010 - RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.Storage/stable/2022-05-01/blob.json#L442
    ❌ R4010 - RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.Storage/stable/2022-05-01/blob.json#L490
    ❌ R4010 - RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.Storage/stable/2022-05-01/blob.json#L550
    ❌ R4010 - RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.Storage/stable/2022-05-01/blob.json#L603
    ❌ R4010 - RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.Storage/stable/2022-05-01/blob.json#L656
    ❌ R4010 - RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.Storage/stable/2022-05-01/blob.json#L708
    ❌ R4010 - RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.Storage/stable/2022-05-01/blob.json#L768
    ❌ R4010 - RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.Storage/stable/2022-05-01/blob.json#L824
    ❌ R4011 - DeleteOperationResponses The delete operation is defined without a 200 or 204 error response implementation,please add it.'
    Location: Microsoft.Storage/stable/2022-05-01/blob.json#L656
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.Storage/stable/2022-05-01/blob.json#L903
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.Storage/stable/2022-05-01/blob.json#L1038
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.Storage/stable/2022-05-01/blob.json#L1151
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.Storage/stable/2022-05-01/blob.json#L1408
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.Storage/stable/2022-05-01/blob.json#L1488
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.Storage/stable/2022-05-01/blob.json#L1492
    ❌ R4037 - MissingTypeObject The schema 'ContainerProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Storage/stable/2022-05-01/blob.json#L885
    ❌ R4037 - MissingTypeObject The schema 'BlobContainer' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Storage/stable/2022-05-01/blob.json#L1020
    ❌ R4037 - MissingTypeObject The schema 'ImmutabilityPolicyProperty' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Storage/stable/2022-05-01/blob.json#L1036
    ❌ R4037 - MissingTypeObject The schema 'ImmutabilityPolicyProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Storage/stable/2022-05-01/blob.json#L1066
    ❌ R4037 - MissingTypeObject The schema 'ImmutabilityPolicy' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Storage/stable/2022-05-01/blob.json#L1089
    ❌ R4037 - MissingTypeObject The schema 'ImmutableStorageWithVersioning' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Storage/stable/2022-05-01/blob.json#L1107
    ️️✔️Avocado succeeded [Detail] [Expand] 
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand] 
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand] 
    Validation passes for SemanticValidation.
    ️️✔️PoliCheck succeeded [Detail] [Expand] 
    Validation passed for PoliCheck.
    ️⚠️SDK Track2 Validation: 1 Warnings warning [Detail]
    • The following tags are being changed in this PR
      • "https://github.com/Azure/azure-rest-api-specs/blob/fe54ce16d37ef4da02eecdc027ac33ac988d050e/specification/storage/resource-manager/readme.md#tag-package-2022-05">storage/resource-manager/readme.md#package-2022-05
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ UnkownSecurityScheme "readme":"storage/resource-manager/readme.md",
    "tag":"package-2022-05",
    "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,
    AzureKey,
    Anonymous"
    ️️✔️PrettierCheck succeeded [Detail] [Expand] 
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand] 
    Validation passes for SpellCheck.
    ️️✔️Lint(RPaaS) succeeded [Detail] [Expand] 
    Validation passes for Lint(RPaaS).
    ️️✔️CadlValidation succeeded [Detail] [Expand] 
    Validation passes for CadlValidation.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 9, 2022 •
    edited
    Loading

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand] 
     Please click here to preview with your @microsoft account.
    ️❌SDK Breaking Change Tracking failed [Detail]

    Breaking Changes Tracking

    ️✔️azure-sdk-for-go - armstorage - 1.1.0
    ❌azure-sdk-for-js - @azure/arm-storage - Approved - 18.0.0
    -	Removed Enum KnownLeaseContainerRequestAction
    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-storage - 20.0.0
    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from a98a48c. SDK Automation 14.0.0 
      command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
warn	File azure-sdk-for-net_tmp/initOutput.json not found to read
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
    • ️✔️Azure.ResourceManager.Storage [View full logs]  [Release SDK Changes] 
      info	[Changelog]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from a98a48c. SDK Automation 14.0.0 
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
cmderr	[automation_generate.sh]  config global `--global`, `--local` are deprecated. Use `--location=global` instead.
    • ️✔️track2_azure-mgmt-storage [View full logs]  [Release SDK Changes] 
      info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added model AllowedMethods
info	[Changelog]   - Added model LeaseContainerRequestEnum
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from a98a48c. SDK Automation 14.0.0 
      command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️armstorage [View full logs]  [Release SDK Changes] 
      info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New const `DirectoryServiceOptionsAADKERB`
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 1 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from a98a48c. SDK Automation 14.0.0 
      command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
    • ️✔️@azure/arm-storage [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added Interface AzureEntityResource
info	[Changelog]   - Added Interface BlobContainer
info	[Changelog]   - Added Interface BlobInventoryPolicy
info	[Changelog]   - Added Interface BlobServiceProperties
info	[Changelog]   - Added Interface DeletedAccount
info	[Changelog]   - Added Interface EncryptionScope
info	[Changelog]   - Added Interface FileServiceProperties
info	[Changelog]   - Added Interface FileShare
info	[Changelog]   - Added Interface FileShareItem
info	[Changelog]   - Added Interface ImmutabilityPolicy
info	[Changelog]   - Added Interface ListContainerItem
info	[Changelog]   - Added Interface ListQueue
info	[Changelog]   - Added Interface LocalUser
info	[Changelog]   - Added Interface ManagementPolicy
info	[Changelog]   - Added Interface ObjectReplicationPolicy
info	[Changelog]   - Added Interface PrivateEndpointConnection
info	[Changelog]   - Added Interface PrivateLinkResource
info	[Changelog]   - Added Interface ProxyResource
info	[Changelog]   - Added Interface QueueServiceProperties
info	[Changelog]   - Added Interface StorageAccount
info	[Changelog]   - Added Interface StorageQueue
info	[Changelog]   - Added Interface Table
info	[Changelog]   - Added Interface TableServiceProperties
info	[Changelog]   - Added Interface TrackedResource
info	[Changelog]   - Added Type Alias AccountType
info	[Changelog]   - Added Type Alias AllowedMethods
info	[Changelog]   - Added Enum KnownAccountType
info	[Changelog]   - Added Enum KnownAllowedMethods
info	[Changelog]   - Enum KnownDirectoryServiceOptions has a new value Aadkerb
info	[Changelog]
info	[Changelog] **Breaking Changes**
info	[Changelog]
info	[Changelog]   - Removed Enum KnownActiveDirectoryPropertiesAccountType
info	[Changelog]   - Removed Enum KnownCorsRuleAllowedMethodsItem
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from a98a48c. Schema Automation 14.0.0 
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
cmderr	[initScript.sh] WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
cmderr	[initScript.sh] npm WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
cmderr	[initScript.sh] npm WARN old lockfile
warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
warn	No file changes detected after generation
    • ️✔️storage [View full logs] 
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from a98a48c. SDK Automation 14.0.0 
      command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
    • ️✔️Az.Storage [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 9, 2022 •
    edited
    Loading

    Generated ApiView

    Language Package Name ApiView Link
    Java azure-resourcemanager-storage-generated https://apiview.dev/Assemblies/Review/4278b4b2f81c4edebf5ca2eabe025bbf
    JavaScript @azure/arm-storage https://apiview.dev/Assemblies/Review/bc9e3cf53fca4dbf913669acac05b674
    .Net Azure.ResourceManager.Storage There is no API change compared with the previous version
    Python track2_azure-mgmt-storage Create ApiView timeout. Package is too large and we cannot create ApiView for it.

    @ghost ghost added the Storage Storage Service (Queues, Blobs, Files) label Aug 9, 2022
    @azure-sdk azure-sdk mentioned this pull request Aug 9, 2022
    Closed
    This was referenced Aug 9, 2022
    Closed
    Closed
    This was referenced Aug 9, 2022
    Closed
    Closed
    Closed
    @jianyexi jianyexi merged commit a98a48c into Azure:main Aug 10, 2022
    This was referenced Aug 10, 2022
    Closed
    Closed
    Closed
    This was referenced Aug 10, 2022
    Closed
    Closed
    Closed
    @ArcturusZhang ArcturusZhang deleted the resolve-duplicate-schema-in-storage branch August 10, 2022 05:41
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @msyyc msyyc msyyc approved these changes

    @blueww blueww blueww approved these changes

    @BigCat20196 BigCat20196 Awaiting requested review from BigCat20196

    @JasonYang-MSFT JasonYang-MSFT Awaiting requested review from JasonYang-MSFT

    Assignees

    @jianyexi jianyexi

    Labels
    Approved-SdkBreakingChange-JavaScript CI-BreakingChange-JavaScript resource-manager Storage Storage Service (Queues, Blobs, Files)
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    6 participants
    @ArcturusZhang @blueww @msyyc @qiaozha @jianyexi @tadelesh